<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::iunordered_map::iterator class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span><span class="m-breadcrumb"><a href="classbn_1_1iunordered__map.html">iunordered_map</a>::<wbr/></span>iterator <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__unordered__map_8h.html">&lt;bn_unordered_map.h&gt;</a></div>
        </h1>
        <p>Non const iterator.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#pub-types">Public types</a></li>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#friends">Friends</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>In contrast to std::unordered_map::iterator, this one is bidirectional.</p>
        <section id="pub-types">
          <h2><a href="#pub-types">Public types</a></h2>
          <dl class="m-doc">
            <dt id="abcecaa981f651aad13667437dc53823c">
              using <a href="#abcecaa981f651aad13667437dc53823c" class="m-doc-self">key_type</a> = <a href="classbn_1_1iunordered__map.html#a4f7f6064ef1e026089464857a3165e85" class="m-doc">iunordered_map::<wbr />key_type</a>
            </dt>
            <dd>Key type alias.</dd>
            <dt id="aa5f6cf86a21d430bb03872f408ca30ee">
              using <a href="#aa5f6cf86a21d430bb03872f408ca30ee" class="m-doc-self">mapped_type</a> = <a href="classbn_1_1iunordered__map.html#a8fa58a32cf5a09daf82f9e4ada2834ea" class="m-doc">iunordered_map::<wbr />mapped_type</a>
            </dt>
            <dd>Value type alias.</dd>
            <dt id="a11e94d9439ec2343de562efe012e1e2b">
              using <a href="#a11e94d9439ec2343de562efe012e1e2b" class="m-doc-self">value_type</a> = <a href="classbn_1_1iunordered__map.html#a57ed8b6f4d4d2605c5220f0d5dee4eaa" class="m-doc">iunordered_map::<wbr />value_type</a>
            </dt>
            <dd>(Key, Value) pair type alias.</dd>
            <dt id="a6b78cadecfe24f0cebbc73492737b30a">
              using <a href="#a6b78cadecfe24f0cebbc73492737b30a" class="m-doc-self">size_type</a> = <a href="classbn_1_1iunordered__map.html#abc2f837a2ace664f7ea256e216f1ace8" class="m-doc">iunordered_map::<wbr />size_type</a>
            </dt>
            <dd>Size type alias.</dd>
            <dt id="adbf578ef29acbb0a8c7da642ce400b0d">
              using <a href="#adbf578ef29acbb0a8c7da642ce400b0d" class="m-doc-self">difference_type</a> = <a href="classbn_1_1iunordered__map.html#ad48ba3bdb04d1f9ad48a5613ef39cfbf" class="m-doc">iunordered_map::<wbr />difference_type</a>
            </dt>
            <dd>Difference type alias.</dd>
            <dt id="a50d70e85b9f1ebc79912d7355d97aa2d">
              using <a href="#a50d70e85b9f1ebc79912d7355d97aa2d" class="m-doc-self">hash_type</a> = <a href="classbn_1_1iunordered__map.html#a27ddc317c4038afa0555434870ce7ecf" class="m-doc">iunordered_map::<wbr />hash_type</a>
            </dt>
            <dd>Hash type alias.</dd>
            <dt id="aa52373e741518dc5c5f9ccfd075f7b58">
              using <a href="#aa52373e741518dc5c5f9ccfd075f7b58" class="m-doc-self">hasher</a> = <a href="classbn_1_1iunordered__map.html#ac4e3ce4a160c8a7f9acf4284b377eb43" class="m-doc">iunordered_map::<wbr />hasher</a>
            </dt>
            <dd>Hash functor alias.</dd>
            <dt id="a19b8b8e19e29118d7a06c015f880d5fd">
              using <a href="#a19b8b8e19e29118d7a06c015f880d5fd" class="m-doc-self">key_equal</a> = <a href="classbn_1_1iunordered__map.html#afce9f48fe6143641da5b0b7f9d7b18a7" class="m-doc">iunordered_map::<wbr />key_equal</a>
            </dt>
            <dd>Equality functor alias.</dd>
            <dt id="a3e0b9160c5e4d2f33f281f91ed2560ad">
              using <a href="#a3e0b9160c5e4d2f33f281f91ed2560ad" class="m-doc-self">reference</a> = <a href="classbn_1_1iunordered__map.html#a03a388054f5b81026ecf1a3c09bd7aab" class="m-doc">iunordered_map::<wbr />reference</a>
            </dt>
            <dd>(Key, Value) pair reference alias.</dd>
            <dt id="a41ae9f53a3eda12901a69f0e550e5ec5">
              using <a href="#a41ae9f53a3eda12901a69f0e550e5ec5" class="m-doc-self">pointer</a> = <a href="classbn_1_1iunordered__map.html#a166e58332fa5451215075a52f6a1476c" class="m-doc">iunordered_map::<wbr />pointer</a>
            </dt>
            <dd>(Key, Value) pair pointer alias.</dd>
            <dt id="a5c5db1d641cee2ad999890c1e583bd65">
              using <a href="#a5c5db1d641cee2ad999890c1e583bd65" class="m-doc-self">iterator_category</a> = bidirectional_iterator_tag
            </dt>
            <dd>Iterator category alias.</dd>
          </dl>
        </section>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt id="a28765649512ee423f8a82d8bfd9f4c4d">
              <span class="m-doc-wrap-bumper"><a href="#a28765649512ee423f8a82d8bfd9f4c4d" class="m-doc-self">iterator</a>(</span><span class="m-doc-wrap">) <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>Default constructor.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a0f7d83591939b377d35b0eaace3dac4a" class="m-doc">operator++</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp;</span>
            </dt>
            <dd>Increments the position.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a15775da200f439c032dd5de4cea435d0" class="m-doc">operator++</a>(</span><span class="m-doc-wrap">int) -&gt; <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a></span>
            </dt>
            <dd>Increments the position.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a91cd88ad2724d8fb496a03a14356d6e5" class="m-doc">operator--</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp;</span>
            </dt>
            <dd>Decrements the position.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#aa73a1d90791123bd571ae9ff683cb029" class="m-doc">operator--</a>(</span><span class="m-doc-wrap">int) -&gt; <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a></span>
            </dt>
            <dd>Decrements the position.</dd>
            <dt id="ab1f376658ad58d960019d325463075aa">
              <span class="m-doc-wrap-bumper">auto <a href="#ab1f376658ad58d960019d325463075aa" class="m-doc-self">operator*</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="#a3e0b9160c5e4d2f33f281f91ed2560ad" class="m-doc">reference</a></span>
            </dt>
            <dd>Returns a reference to the pointed (Key, Value) pair.</dd>
            <dt id="a3fc46e2db50e519c9b2ee8ab58ee44c1">
              <span class="m-doc-wrap-bumper">auto <a href="#a3fc46e2db50e519c9b2ee8ab58ee44c1" class="m-doc-self">operator-&gt;</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="#a41ae9f53a3eda12901a69f0e550e5ec5" class="m-doc">pointer</a></span>
            </dt>
            <dd>Returns a pointer to the pointed (Key, Value) pair.</dd>
          </dl>
        </section>
        <section id="friends">
          <h2><a href="#friends">Friends</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a81d10d7799462c7ca5e7cf19119ca356" class="m-doc">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; a,
              const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; b) -&gt; bool</span>
            </dt>
            <dd>Equal operator.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a55a8ee0e80dad1a7da9d751c25bc0386" class="m-doc">operator!=</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; a,
              const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; b) -&gt; bool</span>
            </dt>
            <dd>Not equal operator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a0f7d83591939b377d35b0eaace3dac4a"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; bn::<wbr />iunordered_map::<wbr />iterator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0f7d83591939b377d35b0eaace3dac4a" class="m-doc-self">operator++</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Increments the position.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a15775da200f439c032dd5de4cea435d0"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a> bn::<wbr />iunordered_map::<wbr />iterator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a15775da200f439c032dd5de4cea435d0" class="m-doc-self">operator++</a>(</span><span class="m-doc-wrap">int)</span></span>
            </h3>
            <p>Increments the position.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td>The iterator before being incremented.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a91cd88ad2724d8fb496a03a14356d6e5"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; bn::<wbr />iunordered_map::<wbr />iterator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a91cd88ad2724d8fb496a03a14356d6e5" class="m-doc-self">operator--</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>Decrements the position.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="aa73a1d90791123bd571ae9ff683cb029"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a> bn::<wbr />iunordered_map::<wbr />iterator::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa73a1d90791123bd571ae9ff683cb029" class="m-doc-self">operator--</a>(</span><span class="m-doc-wrap">int)</span></span>
            </h3>
            <p>Decrements the position.</p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td>The iterator before being decremented.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a81d10d7799462c7ca5e7cf19119ca356"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a81d10d7799462c7ca5e7cf19119ca356" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; a,
              const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; b)</span></span>
            </h3>
            <p>Equal operator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First iterator to compare.</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second iterator to compare.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if the first iterator is equal to the second one, otherwise <code>false</code>.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a55a8ee0e80dad1a7da9d751c25bc0386"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a55a8ee0e80dad1a7da9d751c25bc0386" class="m-doc-self">operator!=</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; a,
              const <a href="classbn_1_1iunordered__map_1_1iterator.html" class="m-doc">iterator</a>&amp; b)</span></span>
            </h3>
            <p>Not equal operator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First iterator to compare.</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second iterator to compare.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if the first iterator is not equal to the second one, otherwise <code>false</code>.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
